Get a specific timeline

GET 
/timestreams/:timestreamId/timelines/:timelineId

Get full details of a specific timeline under a timestream

Request

Path Parameters

timestreamId stringrequired
timelineId stringrequired

Header Parameters

x-api-key passwordrequired

OneBasket API Key

Responses

200

The request has succeeded.

application/json

Schema

Schema

anyOf

Timelines.PrimaryTimelineDto

type stringrequired

Possible values: [Primary]

The type of the timeline

type stringrequired

Possible values: [Primary, Collection, ProductAvailability]

The type of the timeline

Primary

circular(Timelines.PrimaryTimelineDto)

Collection

type stringrequired

Possible values: [Collection]

The type of the timeline

kioskId object

ProductAvailability

type stringrequired

Possible values: [ProductAvailability]

The type of the timeline

kioskId object

id stringrequired

The unique identifier of the timeline

timestreamId stringrequired

The unique identifier of the parent timestream

title stringrequired

The title of the timeline

timeperiods integerrequired

The timeperiods of the timeline

Timelines.CollectionTimelineDto

type stringrequired

Possible values: [Collection]

The type of the timeline

kioskId object

type stringrequired

Possible values: [Primary, Collection, ProductAvailability]

The type of the timeline

Primary

type stringrequired

Possible values: [Primary]

The type of the timeline

Collection

circular(Timelines.CollectionTimelineDto)

ProductAvailability

type stringrequired

Possible values: [ProductAvailability]

The type of the timeline

kioskId object

id stringrequired

The unique identifier of the timeline

timestreamId stringrequired

The unique identifier of the parent timestream

title stringrequired

The title of the timeline

timeperiods integerrequired

The timeperiods of the timeline

Timelines.ProductAvailabilityTimelineDto

type stringrequired

Possible values: [ProductAvailability]

The type of the timeline

kioskId object

type stringrequired

Possible values: [Primary, Collection, ProductAvailability]

The type of the timeline

Primary

type stringrequired

Possible values: [Primary]

The type of the timeline

Collection

type stringrequired

Possible values: [Collection]

The type of the timeline

kioskId object

ProductAvailability

circular(Timelines.ProductAvailabilityTimelineDto)

id stringrequired

The unique identifier of the timeline

timestreamId stringrequired

The unique identifier of the parent timestream

title stringrequired

The title of the timeline

timeperiods integerrequired

The timeperiods of the timeline

Example (from schema)

{}

400

The server could not understand the request due to invalid syntax.

application/json

Schema

Schema

type string

A URI reference [RFC3986] that identifies the problem type.

title string

Possible values: [Bad request]

A short, human-readable summary of the problem type.

status number

Possible values: [400]

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.

detail string

A human-readable explanation specific to this occurrence of the problem.

instance string

A URI reference that identifies the specific occurrence of the problem.

errors objectrequired
property name* object

Example (from schema)

{
  "type": "string",
  "title": "Bad request",
  "status": 400,
  "detail": "string",
  "instance": "string",
  "errors": {}
}

401

Access is unauthorized.

application/json

Schema

Schema

type string

A URI reference [RFC3986] that identifies the problem type.

title string

Possible values: [Unauthorized]

A short, human-readable summary of the problem type.

status number

Possible values: [401]

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.

detail string

A human-readable explanation specific to this occurrence of the problem.

instance string

A URI reference that identifies the specific occurrence of the problem.

Example (from schema)

{
  "type": "string",
  "title": "Unauthorized",
  "status": 401,
  "detail": "string",
  "instance": "string"
}

404

The server cannot find the requested resource.

application/json

Schema

Schema

type string

A URI reference [RFC3986] that identifies the problem type.

title string

Possible values: [Not Found]

A short, human-readable summary of the problem type.

status number

Possible values: [404]

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.

detail string

A human-readable explanation specific to this occurrence of the problem.

instance string

A URI reference that identifies the specific occurrence of the problem.

Example (from schema)

{
  "type": "string",
  "title": "Not Found",
  "status": 404,
  "detail": "string",
  "instance": "string"
}

Loading...